| Package | hl7.fhir.uv.cql |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/cql/https://build.fhir.org/ig/HL7/cql-ig/CapabilityStatement-cql-evaluation-service.html |
| Url | http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service |
| Version | 1.1.0-cibuild |
| Status | draft |
| Date | 2024-06-10T16:43:49+00:00 |
| Name | CQLEvaluationService |
| Title | CQL Evaluation Service |
| Experimental | False |
| Realm | uv |
| Authority | hl7 |
| Description | Capability statement for a service supporting CQL evaluation use cases |
| Kind | requirements |
No resources found
| ImplementationGuide | |
hl7.fhir.uv.cql  | Using CQL with FHIR |
| http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql | CQL CQL |
| http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate | CQL Library Evaluate |
| http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library | CQL Library |
| http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo | CQL Model Info |
| http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module | CQL Module |
| http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library | ELM JSON Library |
| http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library | ELM XML Library |
Note: links and images are rebased to the (stated) source
FHIRjson, xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverRESTful CQL Evaluation Service
CertificatesThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Library | http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library Additional supported profiles: CQL Model Info CQL Module ELM XML Library ELM JSON Library | y | y | date, name, title, identifier, description, status, url, version, composed-of, depends-on |
http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo
http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module
http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library
http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | date | date | |
| SHALL | name | string | |
| SHALL | title | string | |
| SHALL | identifier | token | |
| SHALL | description | string | |
| SHALL | status | token | |
| SHALL | url | uri | |
| SHALL | version | token | |
| SHALL | composed-of | reference | |
| SHALL | depends-on | reference |
{
"resourceType" : "CapabilityStatement",
"id" : "cql-evaluation-service",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">CQL Evaluation Service</h2><ul><li>Implementation Guide Version: 1.1.0-cibuild </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-06-10 16:43:49+0000 </li><li>Published by: HL7 International / Clinical Decision Support </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>RESTful CQL Evaluation Service</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: yes</div><div class=\"col-lg-6\">Security services supported: <code>Certificates</code></div></div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Library1-1\">Library</a></td><td><a href=\"StructureDefinition-cql-library.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library</a><br/><em>Additional supported profiles:</em><br/>��<a href=\"StructureDefinition-cql-modelinfo.html\">CQL Model Info</a><br/>��<a href=\"StructureDefinition-cql-module.html\">CQL Module</a><br/>��<a href=\"StructureDefinition-elm-xml-library.html\">ELM XML Library</a><br/>��<a href=\"StructureDefinition-elm-json-library.html\">ELM JSON Library</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>date, name, title, identifier, description, status, url, version, composed-of, depends-on</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Library1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Library</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-cql-library.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-cql-modelinfo.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo</a><br/><a href=\"StructureDefinition-cql-module.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module</a><br/><a href=\"StructureDefinition-elm-xml-library.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library</a><br/><a href=\"StructureDefinition-elm-json-library.html\">http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong>support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">title</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">description</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">version</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">composed-of</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/library.html#search\">depends-on</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}
],
"url" : "http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service",
"version" : "1.1.0-cibuild",
"name" : "CQLEvaluationService",
"title" : "CQL Evaluation Service",
"status" : "draft",
"experimental" : false,
"date" : "2024-06-10T16:43:49+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "Capability statement for a service supporting CQL evaluation use cases",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"implementationGuide" : [
"http://hl7.org/fhir/uv/cql/ImplementationGuide/hl7.fhir.uv.cql"
],
"rest" : [
{
"mode" : "server",
"documentation" : "RESTful CQL Evaluation Service",
"security" : {
"cors" : true,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "Certificates"
}
]
}
]
},
"resource" : [
{
"type" : "Library",
"profile" : "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library",
"supportedProfile" : [
"http://hl7.org/fhir/uv/cql/StructureDefinition/cql-modelinfo",
"http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module",
"http://hl7.org/fhir/uv/cql/StructureDefinition/elm-xml-library",
"http://hl7.org/fhir/uv/cql/StructureDefinition/elm-json-library"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the available libraries"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search allows clients to find libraries on the server"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-date",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-title",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-description",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-status",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-url",
"type" : "uri"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-version",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type" : "reference"
}
]
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "cql",
"definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "evaluate",
"definition" : "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.